Schema Registry REST API Reference - Link does not work - HDF 3.0.0

[#1]

Hello. I am referencing the Schema Registry overview article at this location - https://docs.hortonworks.com/HDPDocuments/HDF3/HDF-3.0.0/bk_overview/content/ch04s01.html

In the section called "Schema Registry API" is a link to the Schema Registry REST API Reference document. The "Schema Registry REST API Reference" link does not work

Schema Registry API

You can view the full API details included in the Schema Registry REST API Reference document included in this Technical Preview release.

You can view the full API details in the Schema Registry REST API Reference documentation.

When you click the link you receive this error:

<Error> <Code>NoSuchKey</Code> <Message>The specified key does not exist.</Message>

"); vertical-align: bottom; height: 10px;"><Key> HDPDocuments/HDF3/HDF-3.0.0/bk_schema-registry-rest-api-reference/content/index.html </Key>

<RequestId>44BD194720EA0DED</RequestId>

"); vertical-align: bottom; height: 10px;"><HostId> Mmz9LphnoNedL/By94JBQoE2RedYdeljwKq44kyQq3dPKO85mglKhPgZ2WhBRYXGStC5UQyId5I= </HostId>

</Error>

Has anyone found an updated link to the API reference?

[#2 · Accepted solution]

Hi Kirk,

Thanks for raising this. I work on the Schema Registry documentation and I'll investigate the error. I'll update this thread once I have the link working!

[#3]

Hello Sarah. Any updates on when the link will be working? Thanks

[#4]

I'm also looking for documentation Found the below in the registry log which will help while Sarah works on that broken link.

Example:

curl http://localhost:7788/api/v1/schemaregistry/schemas

GET  /api/swagger  
GET  /api/swagger.{type:json|yaml}  
POST /api/v1/schemaregistry/files  
GET  /api/v1/schemaregistry/files/download/{fileId}  
GET  /api/v1/schemaregistry/schemaproviders  
GET  /api/v1/schemaregistry/schemas  
POST /api/v1/schemaregistry/schemas  
GET  /api/v1/schemaregistry/schemas/aggregated  
GET  /api/v1/schemaregistry/schemas/{name}  
GET  /api/v1/schemaregistry/schemas/{name}/aggregated  
POST /api/v1/schemaregistry/schemas/{name}/compatibility  
POST /api/v1/schemaregistry/schemas/{name}/mapping/{serDesId}  
GET  /api/v1/schemaregistry/schemas/{name}/serdes  
GET  /api/v1/schemaregistry/schemas/{name}/versions  
POST /api/v1/schemaregistry/schemas/{name}/versions  
GET  /api/v1/schemaregistry/schemas/{name}/versions/latest  
POST /api/v1/schemaregistry/schemas/{name}/versions/upload  
GET  /api/v1/schemaregistry/schemas/{name}/versions/{version}  
GET  /api/v1/schemaregistry/schemasById/{schemaId}  
GET  /api/v1/schemaregistry/search/schemas  
GET  /api/v1/schemaregistry/search/schemas/aggregated  
GET  /api/v1/schemaregistry/search/schemas/fields  
POST /api/v1/schemaregistry/serdes  
GET  /api/v1/schemaregistry/serdes/{id}  

[#5]

You can access the Schema Registry API Swagger documentation directly from the UI itself.

To do this, append your URL with: /api/swagger/

For example: http://localhost:9090/api/swagger/

[#6]

Thanks this does work for us. Our port is different but I was able to see the api reference.

[#7]

Any news on this? The link in the documentation still does not work (

https://docs.hortonworks.com/HDPDocuments/HDF3/HDF-3.0.0/bk_schema-registry-rest-api-reference/conte..., and at least on my installation (HDP 2.6.4 and HDF 3.0.2), I am unable to see the swagger documentation under the endpoint /api/swagger. The response is:

{"responseMessage":"An exception with message [HTTP 404 Not Found] was thrown while processing request.}

[#8]

I run into the same issue when I try to access the swagger documentation via /api/swagger. My current workaround is to reference the Confluent schema registry API docs here. The APIs aren't an exact 1:1 match, but many of the API calls are the same, so I was able to use that.

[#9]

Hi!

I using SchemaRegistry version 0.5.1. I want develop python schema client, so I want to see REST API. But when i using url like http://localhost:9090/api/swagger/ it return " .

[#10]

After way too much struggling with the same issue, I was finally able to find the REST API URL. It was at http://localhost:<port>/swagger/. My Schema Registry was running on port 7788, so I could hit it from http://localhost:7788/swagger/ (remove the "/api" part of the url)