APapicurio
Search
Artifacts

Search for artifacts by content

Changed on

Returns a paginated list of all artifacts with at least one version that matches the posted content.

post/search/artifacts

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

canonicalboolean

Parameter that can be set to true to indicate that the server should "canonicalize" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the artifactType query parameter.

artifactTypestring
Example:AVRO

Indicates the type of artifact represented by the content being used for the search. This is only needed when using the canonical query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts.

offsetinteger

The number of artifacts to skip before starting to collect the result set. Defaults to 0.

limitinteger

The number of artifacts to return. Defaults to 20.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'name' | 'createdOn'

The field to sort by. Can be one of:

  • name
  • createdOn

Request body */*

string binary required

Response

On a successful response, returns a result set of artifacts - one for each artifact in the registry that matches the criteria.

countinteger required

The total number of artifacts that matched the query that produced the result set (may be more than the number of artifacts in the result set).

Example response

{
  "artifacts": [
    {
      "groupId": "My-Group",
      "id": "Procurement-Invoice",
      "name": "Artifact Name",
      "description": "Description of the artifact",
      "labels": [
        "current",
        "internal"
      ],
      "type": "AVRO",
      "state": "ENABLED",
      "createdBy": "user1",
      "createdOn": "2019-03-22T12:51:19Z"
    }
  ]
}

Changes

  • v229b79a1c2c74Revision changes
    • breaking

      removed the enum value ASYNCAPI from the query request parameter artifactType

    • breaking

      removed the enum value AVRO from the query request parameter artifactType

    • breaking

      removed the enum value GRAPHQL from the query request parameter artifactType

    • breaking

      removed the enum value JSON from the query request parameter artifactType

    • breaking

      removed the enum value KCONNECT from the query request parameter artifactType

    • breaking

      removed the enum value OPENAPI from the query request parameter artifactType

    • breaking

      removed the enum value PROTOBUF from the query request parameter artifactType

    • breaking

      removed the enum value WSDL from the query request parameter artifactType

    • breaking

      removed the enum value XML from the query request parameter artifactType

    • breaking

      removed the enum value XSD from the query request parameter artifactType

    • info

      removed the ASYNCAPI enum value from the // response property for the response status

    • info

      removed the AVRO enum value from the // response property for the response status

    • info

      removed the GRAPHQL enum value from the // response property for the response status

    • info

      removed the JSON enum value from the // response property for the response status

    • info

      removed the KCONNECT enum value from the // response property for the response status

    • info

      removed the OPENAPI enum value from the // response property for the response status

    • info

      removed the PROTOBUF enum value from the // response property for the response status

    • info

      removed the WSDL enum value from the // response property for the response status

    • info

      removed the XML enum value from the // response property for the response status

    • info

      removed the XSD enum value from the // response property for the response status

  • v2e26e4a280eb6Revision changes
    • breaking

      removed the enum value PROTOBUF_FD from the query request parameter artifactType

    • info

      removed the PROTOBUF_FD enum value from the // response property for the response status