openapix

Documentation

Overview

Package openapi contains definitions commonly used in Ory's APIs such as pagination, JSON patches, and more.

Index

• type JSONPatch
• type JSONPatchDocument
• type TokenPaginationHeaders
• type TokenPaginationParams

Types

type JSONPatch

type JSONPatch struct {
	// The operation to be performed. One of "add", "remove", "replace", "move", "copy", or "test".
	//
	// required: true
	// example: replace
	Op string `json:"op"`

	// The path to the target path. Uses JSON pointer notation.
	//
	// Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).
	//
	// required: true
	// example: /name
	Path string `json:"path"`

	// The value to be used within the operations.
	//
	// Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).
	//
	// example: foobar
	Value interface{} `json:"value"`

	// This field is used together with operation "move" and uses JSON Pointer notation.
	//
	// Learn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).
	//
	// example: /name
	From string `json:"from"`
}

A JSONPatch document as defined by RFC 6902

swagger:model jsonPatch

type JSONPatchDocument

type JSONPatchDocument []JSONPatch

A JSONPatchDocument request

swagger:model jsonPatchDocument

type TokenPaginationHeaders

type TokenPaginationHeaders struct {
	// The link header contains pagination links.
	//
	// For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
	//
	// in: header
	Link string `json:"link"`

	// The total number of clients.
	//
	// in: header
	XTotalCount string `json:"x-total-count"`
}

swagger:model tokenPaginationHeaders

type TokenPaginationParams

type TokenPaginationParams struct {
	// Items per page
	//
	// This is the number of items per page to return.
	// For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
	//
	// required: false
	// in: query
	// default: 250
	// min: 1
	// max: 1000
	PageSize int `json:"page_size"`

	// Next Page Token
	//
	// The next page token.
	// For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
	//
	// required: false
	// in: query
	// default: 1
	// min: 1
	PageToken string `json:"page_token"`
}

swagger:model tokenPagination