// Jest Snapshot v1, https://goo.gl/fbAQLP exports[`circular references can derefence circular references 1`] = ` { "components": { "schemas": { "CircularExample": { "properties": { "circular_property": { "additionalProperties": { "$ref": "#/components/schemas/CircularExample", }, "type": "object", }, "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, }, "title": "CircularExample", "type": "object", }, }, }, "info": { "description": "Documentation of services", "title": "Recursive Example", "version": "1.0", }, "openapi": "3.0.0", "paths": { "/api/example": { "get": { "deprecated": false, "description": "example", "operationId": "GetExample", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "circular_property": { "additionalProperties": { "$ref": "#/components/schemas/CircularExample", }, "type": "object", }, "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, }, "title": "CircularExample", "type": "object", }, }, }, "description": "Successful operation", "headers": {}, }, }, "summary": "Get example", }, }, }, } `; exports[`circular references circular references with chained circle ref 1`] = ` { "components": { "schemas": { "Organization": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "user": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "organization": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "user": { "$ref": "#/components/schemas/User", }, }, "title": "Organization", "type": "object", }, }, "title": "User", "type": "object", }, }, "title": "Organization", "type": "object", }, "User": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "organization": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "user": { "$ref": "#/components/schemas/User", }, }, "title": "Organization", "type": "object", }, }, "title": "User", "type": "object", }, }, }, "info": { "description": "Documentation of services", "title": "Recursive Example", "version": "1.0", }, "openapi": "3.0.0", "paths": { "/api/example": { "get": { "deprecated": false, "description": "example", "operationId": "GetExample", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "organization": { "properties": { "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, "user": { "$ref": "#/components/schemas/User", }, }, "title": "Organization", "type": "object", }, }, "title": "User", "type": "object", }, }, }, "description": "Successful operation", "headers": {}, }, }, "summary": "Get example", }, }, }, } `; exports[`circular references circular references with expanded refs 1`] = ` { "components": { "schemas": { "CircularExample": { "properties": { "circular_property": { "additionalProperties": { "$ref": "#/components/schemas/CircularExample", }, "type": "object", }, "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, }, "title": "CircularExample", "type": "object", }, }, }, "info": { "description": "Documentation of services", "title": "Recursive Example", "version": "1.0", }, "openapi": "3.0.0", "paths": { "/api/example": { "get": { "deprecated": false, "description": "example", "operationId": "GetExample", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "circular_property": { "additionalProperties": { "$ref": "#/components/schemas/CircularExample", }, "type": "object", }, "id": { "description": "identifier of the example", "type": "string", }, "name": { "description": "name of the example", "type": "string", }, }, "title": "CircularExample", "type": "object", "x-custom": "this is a custom field for expanding refs", }, }, }, "description": "Successful operation", "headers": {}, }, }, "summary": "Get example", }, }, }, } `; exports[`circular references circular references with multiple refs 1`] = ` { "components": { "schemas": { "UserDetails": { "properties": { "best_friend": { "additionalProperties": { "$ref": "#/components/schemas/UserDetails", }, "type": "object", }, "email": { "description": "joe@maumas-house.net", "type": "string", }, "id": { "description": "Unique ID", "type": "number", }, "name": { "description": "User name", "example": "Joe Mauma", "type": "string", }, }, "title": "UserDetails", "type": "object", }, }, }, "info": { "description": "Self-referencing circular example", "title": "Direct Recursive Example", "version": "1.0", }, "openapi": "3.0.0", "paths": { "/user/details": { "get": { "deprecated": false, "description": "Get User Details", "operationId": "GetUserDetails", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "best_friend": { "additionalProperties": { "$ref": "#/components/schemas/UserDetails", }, "type": "object", }, "email": { "description": "joe@maumas-house.net", "type": "string", }, "id": { "description": "Unique ID", "type": "number", }, "name": { "description": "User name", "example": "Joe Mauma", "type": "string", }, }, "title": "UserDetails", "type": "object", }, }, }, "description": "Successful operation", "headers": {}, }, }, "summary": "Get User Details", "tags": [ "User", ], }, "post": { "deprecated": false, "description": "Get User Details", "operationId": "GetUserDetails", "requestBody": { "content": { "application/json": { "schema": { "properties": { "best_friend": { "additionalProperties": { "$ref": "#/components/schemas/UserDetails", }, "type": "object", }, "email": { "description": "joe@maumas-house.net", "type": "string", }, "id": { "description": "Unique ID", "type": "number", }, "name": { "description": "User name", "example": "Joe Mauma", "type": "string", }, }, "title": "UserDetails", "type": "object", }, }, }, "description": "Successful operation", }, "responses": { "200": { "content": {}, "description": "Successful operation", "headers": {}, }, }, "summary": "Get User Details", "tags": [ "User", ], }, }, }, "tags": [ { "name": "UserDetails", }, ], } `; exports[`circular references does not parse date strings as JS dates 1`] = ` { "object": { "2022-01-01": "GHI", "2022-01-02": "DEF", "key1": "ABC", }, } `; exports[`dereferencing openapi files can parse a json schema spec with external references 1`] = ` { "jsonLike": { "example": { "token": "11111111", "user": { "name": "Homer", }, }, "properties": { "token": { "type": "string", }, "user": { "example": { "name": "Homer", }, "properties": { "name": { "type": "string", }, }, "required": [ "name", ], "type": "object", }, }, "required": [ "user", "token", ], "type": "object", }, "sourcemap": JsonSchemaSourcemap { "files": [ { "ast": null, "contents": "User: type: object required: [name] properties: name: type: string example: name: 'Homer' ", "index": null, "path": "/inputs/openapi3-with-references/definitions.yaml", "sha256": "908a3b564fb7ad4ecda6a23ad9b80dd0405819d57393a260e7a8befe749a7547", }, { "ast": null, "contents": "type: object required: [user, token] properties: token: type: string user: $ref: 'definitions.yaml#/User' example: token: '11111111' user: $ref: 'definitions.yaml#/User/example' ", "index": null, "path": "/inputs/openapi3-with-references/external-multiple.yaml", "sha256": "a5a9b65755e01792c0a1b9d4fd0a519874236357fd647babfcb9bfa19c616c87", }, ], "refMappings": { "/example/user": [ 1, "/User/example", ], "/properties/user": [ 1, "/User", ], }, "rootFilePath": "/inputs/openapi3-with-references/external-multiple.yaml", }, } `; exports[`dereferencing openapi files can parse a json schema spec with external references to the same file 1`] = ` { "jsonLike": { "example": { "user": { "name": "Homer", }, "user2": { "name": "Homer", }, }, "properties": {}, "required": [], "type": "object", }, "sourcemap": JsonSchemaSourcemap { "files": [ { "ast": null, "contents": "User: type: object required: [name] properties: name: type: string example: name: 'Homer' ", "index": null, "path": "/inputs/openapi3-with-references/definitions.yaml", "sha256": "908a3b564fb7ad4ecda6a23ad9b80dd0405819d57393a260e7a8befe749a7547", }, { "ast": null, "contents": "type: object required: [] properties: {} example: user: $ref: 'definitions.yaml#/User/example' user2: $ref: 'definitions.yaml#/User/example' ", "index": null, "path": "/inputs/openapi3-with-references/external-multiple-branches.yaml", "sha256": "791c2bcfaa15f53ffbe8841ce742013aad1469db97bbc108133b305614ec80ac", }, ], "refMappings": { "/example/user": [ 1, "/User/example", ], "/example/user2": [ 1, "/User/example", ], }, "rootFilePath": "/inputs/openapi3-with-references/external-multiple-branches.yaml", }, } `; exports[`dereferencing openapi files can parse a json schema spec with internal references to external references 1`] = ` { "jsonLike": { "components": { "FieldA": { "example": { "example": { "name": "Homer", }, "properties": { "name": { "type": "string", }, }, "required": [ "name", ], "type": "object", }, "type": "string", }, }, "example": { "internalRef": { "example": { "example": { "name": "Homer", }, "properties": { "name": { "type": "string", }, }, "required": [ "name", ], "type": "object", }, "type": "string", }, "user": { "name": "Homer", }, }, "properties": { "token": { "type": "string", }, "user": { "example": { "name": "Homer", }, "properties": { "name": { "type": "string", }, }, "required": [ "name", ], "type": "object", }, }, "required": [ "user", "token", ], "type": "object", }, "sourcemap": JsonSchemaSourcemap { "files": [ { "ast": null, "contents": "User: type: object required: [name] properties: name: type: string example: name: 'Homer' ", "index": null, "path": "/inputs/openapi3-with-references/definitions.yaml", "sha256": "908a3b564fb7ad4ecda6a23ad9b80dd0405819d57393a260e7a8befe749a7547", }, { "ast": null, "contents": "type: object required: [user, token] properties: token: type: string user: $ref: 'definitions.yaml#/User' example: internalRef: $ref: '#/components/FieldA' user: $ref: 'definitions.yaml#/User/example' components: FieldA: type: string example: $ref: 'definitions.yaml#/User' ", "index": null, "path": "/inputs/openapi3-with-references/internal-multiple.yaml", "sha256": "0efe164edc40303433096775fb0622be111a5bba5dea332c6183ba26e2e65bfc", }, ], "refMappings": { "/components/FieldA/example": [ 1, "/User", ], "/example/internalRef": [ 0, "/components/FieldA", ], "/example/internalRef/example": [ 1, "/User", ], "/example/user": [ 1, "/User/example", ], "/properties/user": [ 1, "/User", ], }, "rootFilePath": "/inputs/openapi3-with-references/internal-multiple.yaml", }, } `; exports[`dereferencing openapi files can parse an OpenAPI file and have valid sourcemap 1`] = ` { "jsonLike": { "components": { "schemas": { "ApiResponse": { "properties": { "code": { "format": "int32", "type": "integer", }, "message": { "type": "string", }, "type": { "type": "string", }, }, "type": "object", }, "Category": { "properties": { "id": { "format": "int64", "type": "integer", }, "name": { "type": "string", }, }, "type": "object", "xml": { "name": "Category", }, }, "Order": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, "Pet": { "properties": { "category": { "properties": { "id": { "format": "int64", "type": "integer", }, "name": { "type": "string", }, }, "type": "object", "xml": { "name": "Category", }, }, "id": { "format": "int64", "type": "integer", }, "name": { "example": "doggie", "type": "string", }, "photoUrls": { "items": { "type": "string", }, "type": "array", "xml": { "name": "photoUrl", "wrapped": true, }, }, "status": { "description": "pet status in the store", "enum": [ "available", "pending", "sold", ], "type": "string", }, "tags": { "items": { "properties": { "id": { "format": "int64", "type": "integer", }, "name": { "type": "string", }, }, "type": "object", "xml": { "name": "Tag", }, }, "type": "array", "xml": { "name": "tag", "wrapped": true, }, }, }, "required": [ "name", "photoUrls", ], "type": "object", "xml": { "name": "Pet", }, }, "Tag": { "properties": { "id": { "format": "int64", "type": "integer", }, "name": { "type": "string", }, }, "type": "object", "xml": { "name": "Tag", }, }, "User": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, }, "securitySchemes": { "api_key": { "in": "header", "name": "api_key", "type": "apiKey", }, "petstore_auth": { "flows": { "implicit": { "authorizationUrl": "http://petstore.swagger.io/oauth/dialog", "scopes": { "read:pets": "read your pets", "write:pets": "modify pets in your account", }, }, }, "type": "oauth2", }, }, }, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io", }, "info": { "contact": { "email": "apiteam@swagger.io", }, "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key \`special-key\` to test the authorization filters.", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html", }, "termsOfService": "http://swagger.io/terms/", "title": "Swagger Petstore", "version": "1.0.0", }, "openapi": "3.0.1", "paths": { "/pet/{petId}/uploadImage": { "post": { "operationId": "uploadFile", "parameters": [ { "description": "ID of pet to update", "in": "path", "name": "petId", "required": true, "schema": { "format": "int64", "type": "integer", }, }, ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "additionalMetadata": { "description": "Additional data to pass to server", "type": "string", }, "file": { "description": "file to upload", "format": "binary", "type": "string", }, }, }, }, }, }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int32", "type": "integer", }, "message": { "type": "string", }, "type": { "type": "string", }, }, "type": "object", }, }, }, "description": "successful operation", }, }, "security": [ { "petstore_auth": [ "write:pets", "read:pets", ], }, ], "summary": "uploads an image", "tags": [ "pet", ], }, }, "/store/inventory": { "get": { "description": "Returns a map of status codes to quantities", "operationId": "getInventory", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "format": "int32", "type": "integer", }, "type": "object", }, }, }, "description": "successful operation", }, }, "security": [ { "api_key": [], }, ], "summary": "Returns pet inventories by status", "tags": [ "store", ], }, }, "/store/order": { "post": { "operationId": "placeOrder", "requestBody": { "content": { "*/*": { "schema": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, }, }, "description": "order placed for purchasing the pet", "required": true, }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, }, "application/xml": { "schema": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, }, }, "description": "successful operation", }, "400": { "content": {}, "description": "Invalid Order", }, }, "summary": "Place an order for a pet", "tags": [ "store", ], "x-codegen-request-body-name": "body", }, }, "/store/order/{orderId}": { "delete": { "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId": "deleteOrder", "parameters": [ { "description": "ID of the order that needs to be deleted", "in": "path", "name": "orderId", "required": true, "schema": { "format": "int64", "minimum": 1, "type": "integer", }, }, ], "responses": { "400": { "content": {}, "description": "Invalid ID supplied", }, "404": { "content": {}, "description": "Order not found", }, }, "summary": "Delete purchase order by ID", "tags": [ "store", ], }, "get": { "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId": "getOrderById", "parameters": [ { "description": "ID of pet that needs to be fetched", "in": "path", "name": "orderId", "required": true, "schema": { "format": "int64", "maximum": 10, "minimum": 1, "type": "integer", }, }, ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, }, "application/xml": { "schema": { "properties": { "complete": { "default": false, "type": "boolean", }, "id": { "format": "int64", "type": "integer", }, "petId": { "format": "int64", "type": "integer", }, "quantity": { "format": "int32", "type": "integer", }, "shipDate": { "format": "date-time", "type": "string", }, "status": { "description": "Order Status", "enum": [ "placed", "approved", "delivered", ], "type": "string", }, }, "type": "object", "xml": { "name": "Order", }, }, }, }, "description": "successful operation", }, "400": { "content": {}, "description": "Invalid ID supplied", }, "404": { "content": {}, "description": "Order not found", }, }, "summary": "Find purchase order by ID", "tags": [ "store", ], }, }, "/user": { "post": { "description": "This can only be done by the logged in user.", "operationId": "createUser", "requestBody": { "content": { "*/*": { "schema": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, }, }, "description": "Created user object", "required": true, }, "responses": { "default": { "content": {}, "description": "successful operation", }, }, "summary": "Create user", "tags": [ "user", ], "x-codegen-request-body-name": "body", }, }, "/user/createWithArray": { "post": { "operationId": "createUsersWithArrayInput", "requestBody": { "content": { "*/*": { "schema": { "items": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, "type": "array", }, }, }, "description": "List of user object", "required": true, }, "responses": { "default": { "content": {}, "description": "successful operation", }, }, "summary": "Creates list of users with given input array", "tags": [ "user", ], "x-codegen-request-body-name": "body", }, }, "/user/createWithList": { "post": { "operationId": "createUsersWithListInput", "requestBody": { "content": { "*/*": { "schema": { "items": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, "type": "array", }, }, }, "description": "List of user object", "required": true, }, "responses": { "default": { "content": {}, "description": "successful operation", }, }, "summary": "Creates list of users with given input array", "tags": [ "user", ], "x-codegen-request-body-name": "body", }, }, "/user/login": { "get": { "operationId": "loginUser", "parameters": [ { "description": "The user name for login", "in": "query", "name": "username", "required": true, "schema": { "type": "string", }, }, { "description": "The password for login in clear text", "in": "query", "name": "password", "required": true, "schema": { "type": "string", }, }, ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string", }, }, "application/xml": { "schema": { "type": "string", }, }, }, "description": "successful operation", "headers": { "X-Expires-After": { "description": "date in UTC when token expires", "schema": { "format": "date-time", "type": "string", }, }, "X-Rate-Limit": { "description": "calls per hour allowed by the user", "schema": { "format": "int32", "type": "integer", }, }, }, }, "400": { "content": {}, "description": "Invalid username/password supplied", }, }, "summary": "Logs user into the system", "tags": [ "user", ], }, }, "/user/logout": { "get": { "operationId": "logoutUser", "responses": { "default": { "content": {}, "description": "successful operation", }, }, "summary": "Logs out current logged in user session", "tags": [ "user", ], }, }, "/user/{username}": { "delete": { "description": "This can only be done by the logged in user.", "operationId": "deleteUser", "parameters": [ { "description": "The name that needs to be deleted", "in": "path", "name": "username", "required": true, "schema": { "type": "string", }, }, ], "responses": { "400": { "content": {}, "description": "Invalid username supplied", }, "404": { "content": {}, "description": "User not found", }, }, "summary": "Delete user", "tags": [ "user", ], }, "get": { "operationId": "getUserByName", "parameters": [ { "description": "The name that needs to be fetched. Use user1 for testing. ", "in": "path", "name": "username", "required": true, "schema": { "type": "string", }, }, ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, }, "application/xml": { "schema": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, }, }, "description": "successful operation", }, "400": { "content": {}, "description": "Invalid username supplied", }, "404": { "content": {}, "description": "User not found", }, }, "summary": "Get user by user name", "tags": [ "user", ], }, "put": { "description": "This can only be done by the logged in user.", "operationId": "updateUser", "parameters": [ { "description": "name that need to be updated", "in": "path", "name": "username", "required": true, "schema": { "type": "string", }, }, ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "email": { "type": "string", }, "firstName": { "type": "string", }, "id": { "format": "int64", "type": "integer", }, "lastName": { "type": "string", }, "password": { "type": "string", }, "phone": { "type": "string", }, "userStatus": { "description": "User Status", "format": "int32", "type": "integer", }, "username": { "type": "string", }, }, "type": "object", "xml": { "name": "User", }, }, }, }, "description": "Updated user object", "required": true, }, "responses": { "400": { "content": {}, "description": "Invalid user supplied", }, "404": { "content": {}, "description": "User not found", }, }, "summary": "Updated user", "tags": [ "user", ], "x-codegen-request-body-name": "body", }, }, }, "servers": [ { "url": "https://petstore.swagger.io/v2", }, { "url": "http://petstore.swagger.io/v2", }, ], "tags": [ { "description": "Everything about your Pets", "externalDocs": { "description": "Find out more", "url": "http://swagger.io", }, "name": "pet", }, { "description": "Access to Petstore orders", "name": "store", }, { "description": "Operations about user", "externalDocs": { "description": "Find out more about our store", "url": "http://swagger.io", }, "name": "user", }, ], }, "sourcemap": JsonSchemaSourcemap { "files": [ { "ast": null, "contents": "{ "openapi": "3.0.1", "info": { "title": "Swagger Petstore", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key \`special-key\` to test the authorization filters.", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "apiteam@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" }, "servers": [ { "url": "https://petstore.swagger.io/v2" }, { "url": "http://petstore.swagger.io/v2" } ], "tags": [ { "name": "pet", "description": "Everything about your Pets", "externalDocs": { "description": "Find out more", "url": "http://swagger.io" } }, { "name": "store", "description": "Access to Petstore orders" }, { "name": "user", "description": "Operations about user", "externalDocs": { "description": "Find out more about our store", "url": "http://swagger.io" } } ], "paths": { "/pet/{petId}/uploadImage": { "post": { "tags": [ "pet" ], "summary": "uploads an image", "operationId": "uploadFile", "parameters": [ { "name": "petId", "in": "path", "description": "ID of pet to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "additionalMetadata": { "type": "string", "description": "Additional data to pass to server" }, "file": { "type": "string", "description": "file to upload", "format": "binary" } } } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/store/inventory": { "get": { "tags": [ "store" ], "summary": "Returns pet inventories by status", "description": "Returns a map of status codes to quantities", "operationId": "getInventory", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } } } }, "security": [ { "api_key": [] } ] } }, "/store/order": { "post": { "tags": [ "store" ], "summary": "Place an order for a pet", "operationId": "placeOrder", "requestBody": { "description": "order placed for purchasing the pet", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Order" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid Order", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/order/{orderId}": { "get": { "tags": [ "store" ], "summary": "Find purchase order by ID", "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", "operationId": "getOrderById", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of pet that needs to be fetched", "required": true, "schema": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Order" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid ID supplied", "content": {} }, "404": { "description": "Order not found", "content": {} } } }, "delete": { "tags": [ "store" ], "summary": "Delete purchase order by ID", "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", "operationId": "deleteOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of the order that needs to be deleted", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Invalid ID supplied", "content": {} }, "404": { "description": "Order not found", "content": {} } } } }, "/user": { "post": { "tags": [ "user" ], "summary": "Create user", "description": "This can only be done by the logged in user.", "operationId": "createUser", "requestBody": { "description": "Created user object", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "default": { "description": "successful operation", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/user/createWithArray": { "post": { "tags": [ "user" ], "summary": "Creates list of users with given input array", "operationId": "createUsersWithArrayInput", "requestBody": { "description": "List of user object", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "required": true }, "responses": { "default": { "description": "successful operation", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/user/createWithList": { "post": { "tags": [ "user" ], "summary": "Creates list of users with given input array", "operationId": "createUsersWithListInput", "requestBody": { "description": "List of user object", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "required": true }, "responses": { "default": { "description": "successful operation", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/user/login": { "get": { "tags": [ "user" ], "summary": "Logs user into the system", "operationId": "loginUser", "parameters": [ { "name": "username", "in": "query", "description": "The user name for login", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password for login in clear text", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": { "X-Rate-Limit": { "description": "calls per hour allowed by the user", "schema": { "type": "integer", "format": "int32" } }, "X-Expires-After": { "description": "date in UTC when token expires", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid username/password supplied", "content": {} } } } }, "/user/logout": { "get": { "tags": [ "user" ], "summary": "Logs out current logged in user session", "operationId": "logoutUser", "responses": { "default": { "description": "successful operation", "content": {} } } } }, "/user/{username}": { "get": { "tags": [ "user" ], "summary": "Get user by user name", "operationId": "getUserByName", "parameters": [ { "name": "username", "in": "path", "description": "The name that needs to be fetched. Use user1 for testing. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Invalid username supplied", "content": {} }, "404": { "description": "User not found", "content": {} } } }, "put": { "tags": [ "user" ], "summary": "Updated user", "description": "This can only be done by the logged in user.", "operationId": "updateUser", "parameters": [ { "name": "username", "in": "path", "description": "name that need to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated user object", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "400": { "description": "Invalid user supplied", "content": {} }, "404": { "description": "User not found", "content": {} } }, "x-codegen-request-body-name": "body" }, "delete": { "tags": [ "user" ], "summary": "Delete user", "description": "This can only be done by the logged in user.", "operationId": "deleteUser", "parameters": [ { "name": "username", "in": "path", "description": "The name that needs to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid username supplied", "content": {} }, "404": { "description": "User not found", "content": {} } } } } }, "components": { "schemas": { "Order": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "petId": { "type": "integer", "format": "int64" }, "quantity": { "type": "integer", "format": "int32" }, "shipDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "description": "Order Status", "enum": [ "placed", "approved", "delivered" ] }, "complete": { "type": "boolean", "default": false } }, "xml": { "name": "Order" } }, "Category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "xml": { "name": "Category" } }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "userStatus": { "type": "integer", "description": "User Status", "format": "int32" } }, "xml": { "name": "User" } }, "Tag": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "xml": { "name": "Tag" } }, "Pet": { "required": [ "name", "photoUrls" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/components/schemas/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "xml": { "name": "photoUrl", "wrapped": true }, "items": { "type": "string" } }, "tags": { "type": "array", "xml": { "name": "tag", "wrapped": true }, "items": { "$ref": "#/components/schemas/Tag" } }, "status": { "type": "string", "description": "pet status in the store", "enum": [ "available", "pending", "sold" ] } }, "xml": { "name": "Pet" } }, "ApiResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "message": { "type": "string" } } } }, "securitySchemes": { "petstore_auth": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "http://petstore.swagger.io/oauth/dialog", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } } } }, "api_key": { "type": "apiKey", "name": "api_key", "in": "header" } } } } ", "index": null, "path": "/inputs/openapi3/petstore0.json", "sha256": "e810fa20b4de25520219a46efab67a741ba3a50b9368086e645d52c9e52ce442", }, ], "refMappings": { "/components/schemas/Pet/properties/category": [ 0, "/components/schemas/Category", ], "/components/schemas/Pet/properties/tags/items": [ 0, "/components/schemas/Tag", ], "/paths/~1pet~1{petId}~1uploadImage/post/responses/200/content/application~1json/schema": [ 0, "/components/schemas/ApiResponse", ], "/paths/~1store~1order/post/requestBody/content/*~1*/schema": [ 0, "/components/schemas/Order", ], "/paths/~1store~1order/post/responses/200/content/application~1json/schema": [ 0, "/components/schemas/Order", ], "/paths/~1store~1order/post/responses/200/content/application~1xml/schema": [ 0, "/components/schemas/Order", ], "/paths/~1store~1order~1{orderId}/get/responses/200/content/application~1json/schema": [ 0, "/components/schemas/Order", ], "/paths/~1store~1order~1{orderId}/get/responses/200/content/application~1xml/schema": [ 0, "/components/schemas/Order", ], "/paths/~1user/post/requestBody/content/*~1*/schema": [ 0, "/components/schemas/User", ], "/paths/~1user~1createWithArray/post/requestBody/content/*~1*/schema/items": [ 0, "/components/schemas/User", ], "/paths/~1user~1createWithList/post/requestBody/content/*~1*/schema/items": [ 0, "/components/schemas/User", ], "/paths/~1user~1{username}/get/responses/200/content/application~1json/schema": [ 0, "/components/schemas/User", ], "/paths/~1user~1{username}/get/responses/200/content/application~1xml/schema": [ 0, "/components/schemas/User", ], "/paths/~1user~1{username}/put/requestBody/content/*~1*/schema": [ 0, "/components/schemas/User", ], }, "rootFilePath": "/inputs/openapi3/petstore0.json", }, } `; exports[`dereferencing openapi files can parse an OpenAPI file with an empty url ref 1`] = ` { "info": { "title": "Empty", "version": "0.0.0", }, "openapi": "3.0.1", "paths": { "/abc": { "get": { "responses": { "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, }, }, }, } `; exports[`dereferencing openapi files can parse an OpenAPI file with local files and external urls 1`] = ` { "components": { "parameters": { "ThingId": { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, }, "schemas": { "ThingAttributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "ThingCollection": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "type": "array", }, "ThingCollectionResponse": { "description": "Response containing a collection of thing resource objects", "properties": { "data": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "first": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "last": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "next": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "prev": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, "ThingRelationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "ThingResource": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "ThingResourceResponse": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "self": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "info": { "title": "v3", "version": "3.0.0", }, "openapi": "3.0.3", "paths": { "/thing": { "get": { "description": "List instances of thing", "operationId": "listThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "in": "query", "name": "version", "required": true, "schema": { "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a collection of thing resource objects", "properties": { "data": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "first": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "last": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "next": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "prev": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Returns a list of thing instances", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "tags": [ "Thing", ], }, "post": { "description": "Create a new thing", "operationId": "createThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "in": "query", "name": "version", "required": true, "schema": { "type": "string", }, }, ], "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "self": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Created thing successfully", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "tags": [ "Thing", ], }, }, "/thing/{thing_id}": { "delete": { "description": "Delete an instance of thing", "operationId": "deleteThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "in": "query", "name": "version", "required": true, "schema": { "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "204": { "description": "The operation completed successfully with no content", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "tags": [ "Thing", ], }, "get": { "description": "Get an instance of thing", "operationId": "getThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "in": "query", "name": "version", "required": true, "schema": { "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "self": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Returns an instance of thing", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "tags": [ "Thing", ], }, "patch": { "description": "Update an instance of thing", "operationId": "updateThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "in": "query", "name": "version", "required": true, "schema": { "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "strangeness": { "description": "The amount of strangeness this thing adds or removes from the situation.", "example": 42, "type": "number", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string", }, "type": { "type": "string", }, }, "required": [ "type", "id", ], }, "links": { "additionalProperties": false, "properties": { "related": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "sometype", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "properties": { "self": { "oneOf": [ { "type": "string", }, { "additionalProperties": false, "properties": { "href": { "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Instance of thing is updated.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "204": { "description": "The operation completed successfully with no content", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "errors": { "items": { "additionalProperties": false, "properties": { "detail": { "type": "string", }, "id": { "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "type": "object", }, "source": { "additionalProperties": false, "properties": { "parameter": { "type": "string", }, "pointer": { "type": "string", }, }, "type": "object", }, "status": { "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "properties": { "version": { "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "schema": { "pattern": "^(wip|work-in-progress|experimental|beta|(([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9])))$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "tags": [ "Thing", ], }, }, }, "servers": [ { "description": "Public Snyk API", "url": "https://api.snyk.io/v3", }, ], "tags": [ { "description": "Short description of what Thing represents", "name": "Thing", }, ], "x-snyk-api-stability": "experimental", } `; exports[`dereferencing openapi files can parse an OpenAPI file with nested external urls 1`] = ` { "components": { "parameters": { "OrgId": { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, "ThingId": { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, }, "schemas": { "ThingAttributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "ThingCollection": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "type": "array", }, "ThingCollectionResponse": { "description": "Response containing a collection of thing resource objects", "properties": { "data": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K", "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K", "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K", }, "properties": { "first": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "last": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "next": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "prev": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, "ThingRelationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "ThingResource": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "ThingResourceResponse": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "self": "https://example.com/api/this_resource", }, "properties": { "self": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "info": { "title": "v3", "version": "3.0.0", }, "openapi": "3.0.3", "paths": { "/orgs/{org_id}/thing": { "get": { "description": "List instances of thing", "operationId": "listThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "example": "2021-06-04", "in": "query", "name": "version", "required": true, "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a collection of thing resource objects", "properties": { "data": { "items": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K", "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K", "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K", }, "properties": { "first": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "last": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "next": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, "prev": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Returns a list of thing instances", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "summary": "List instances of thing", "tags": [ "Thing", ], }, "post": { "description": "Create a new thing", "operationId": "createThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "example": "2021-06-04", "in": "query", "name": "version", "required": true, "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "self": "https://example.com/api/this_resource", }, "properties": { "self": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Created thing successfully", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "summary": "Create a new thing", "tags": [ "Thing", ], }, }, "/orgs/{org_id}/thing/{thing_id}": { "delete": { "description": "Delete an instance of thing", "operationId": "deleteThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "example": "2021-06-04", "in": "query", "name": "version", "required": true, "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "204": { "description": "The operation completed successfully with no content", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "summary": "Delete an instance of thing", "tags": [ "Thing", ], }, "get": { "description": "Get an instance of thing", "operationId": "getThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "example": "2021-06-04", "in": "query", "name": "version", "required": true, "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "self": "https://example.com/api/this_resource", }, "properties": { "self": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Returns an instance of thing", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "summary": "Get an instance of thing", "tags": [ "Thing", ], }, "patch": { "description": "Update an instance of thing", "operationId": "updateThing", "parameters": [ { "description": "The requested version of the endpoint to process the request", "example": "2021-06-04", "in": "query", "name": "version", "required": true, "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, { "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, { "description": "Unique identifier for thing instances", "in": "path", "name": "thing_id", "required": true, "schema": { "format": "uuid", "type": "string", }, }, ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "description": "Response containing a single thing resource object", "properties": { "data": { "additionalProperties": false, "description": "thing resource object", "properties": { "attributes": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when this instance of thing was created.", "example": "2021-10-05T13:23:17Z", "format": "date-time", "type": "string", }, "description": { "description": "User-friendly description of this instance of thing.", "example": "This is a thing named thing.", "type": "string", }, "name": { "description": "Name of this instance of thing.", "example": "thing", "type": "string", }, "updated": { "description": "Timestamp when this instance of thing was last updated.", "example": "2021-10-05T13:25:29Z", "format": "date-time", "type": "string", }, }, "type": "object", }, "id": { "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", "format": "uuid", "type": "string", }, "relationships": { "additionalProperties": false, "properties": { "example": { "example": { "data": { "id": "4a72d1db-b465-4764-99e1-ecedad03b06a", "type": "resource", }, "links": { "related": { "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a", }, }, }, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "example": "4a72d1db-b465-4764-99e1-ecedad03b06a", "format": "uuid", "type": "string", }, "type": { "description": "Type of the related resource", "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "required": [ "type", "id", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "related": "https://example.com/api/other_resource", }, "properties": { "related": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "data", "links", ], "type": "object", }, }, "type": "object", }, "type": { "example": "resource", "pattern": "^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$", "type": "string", }, }, "type": "object", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, "links": { "additionalProperties": false, "example": { "self": "https://example.com/api/this_resource", }, "properties": { "self": { "example": "https://example.com/api/resource", "oneOf": [ { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, { "additionalProperties": false, "example": { "href": "https://example.com/api/resource", }, "properties": { "href": { "description": "A string containing the link’s URL.", "example": "https://example.com/api/resource", "type": "string", }, "meta": { "additionalProperties": true, "description": "Free-form object that may contain non-standard information.", "example": { "key1": "value1", "key2": { "sub_key": "sub_value", }, "key3": [ "array_value1", "array_value2", ], }, "type": "object", }, }, "required": [ "href", ], "type": "object", }, ], }, }, "type": "object", }, }, "type": "object", }, }, }, "description": "Instance of thing is updated.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "204": { "description": "The operation completed successfully with no content", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, "500": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "example": { "errors": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "jsonapi": { "version": "1.0", }, }, "properties": { "errors": { "example": [ { "detail": "Permission denied for this resource", "status": "403", }, ], "items": { "additionalProperties": false, "example": { "detail": "Not Found", "status": "404", }, "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The request was missing these required fields: ...", "type": "string", }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string", }, "meta": { "additionalProperties": true, "example": { "key": "value", }, "type": "object", }, "source": { "additionalProperties": false, "example": { "pointer": "/data/attributes", }, "properties": { "parameter": { "description": "A string indicating which URI query parameter caused the error.", "example": "param1", "type": "string", }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", "example": "/data/attributes", "type": "string", }, }, "type": "object", }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "example": "400", "pattern": "^[45]\\d\\d$", "type": "string", }, }, "required": [ "status", "detail", ], "type": "object", }, "minItems": 1, "type": "array", }, "jsonapi": { "additionalProperties": false, "example": { "version": "1.0", }, "properties": { "version": { "description": "Version of the JSON API specification this server supports.", "example": "1.0", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string", }, }, "required": [ "version", ], "type": "object", }, }, "required": [ "jsonapi", "errors", ], "type": "object", }, }, }, "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC: https://tools.ietf.org/id/draft-dalal-deprecation-header-01.html ", "example": "2021-07-01T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, "snyk-request-id": { "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID. ", "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", "schema": { "format": "uuid", "type": "string", }, }, "snyk-version-lifecycle-stage": { "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint. ", "schema": { "enum": [ "wip", "experimental", "beta", "ga", "deprecated", "sunset", ], "example": "ga", "type": "string", }, }, "snyk-version-requested": { "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", "type": "string", }, }, "snyk-version-served": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { "description": "Resolved API version", "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", "type": "string", }, }, "sunset": { "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information: https://datatracker.ietf.org/doc/html/rfc8594 ", "example": "2021-08-02T00:00:00Z", "schema": { "format": "date-time", "type": "string", }, }, }, }, }, "summary": "Update an instance of thing", "tags": [ "Thing", ], }, }, }, "servers": [ { "description": "Public Snyk API", "url": "https://api.snyk.io/v3", }, ], "tags": [ { "description": "Short description of what Thing represents", "name": "Thing", }, ], "x-snyk-api-stability": "experimental", } `; exports[`dereferencing openapi files with external file resolver uses a custom ref handler to replace non-url refs 1`] = ` { "value": { "value_inside": "it is inside", }, } `;