Skip to content

Commit

Permalink
Regenerate OpenAPI Client
Browse files Browse the repository at this point in the history
Try number 2.
  • Loading branch information
xylo04 committed Jan 20, 2025
1 parent 418a576 commit 27d7d59
Show file tree
Hide file tree
Showing 27 changed files with 1,943 additions and 390 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/assign_pr.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Auto Assign'
name: "Auto Assign"
on:
pull_request:
types: [opened, ready_for_review]
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ _testmain.go
# IDE files
*.iml
.idea/

.travis.yml
git_push.sh
6 changes: 1 addition & 5 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

go.mod
git_push.sh
.gitignore
.travis.yml
client.go
README.md
15 changes: 15 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.travis.yml
api/openapi.yaml
api_default.go
client.go
configuration.go
docs/DefaultAPI.md
docs/Request.md
docs/Response.md
git_push.sh
go.mod
go.sum
model_request.go
model_response.go
response.go
utils.go
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.3.1
7.10.0
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@

# Go API client for QRZ.com Logbook

A GoLang client library for QRZ.com's Logbook data service. The service
provides real-time access to information from QRZ.com logbooks. The API is
documented [here](https://www.qrz.com/docs/logbook/QRZLogbookAPI.html).
A GoLang client library for QRZ.com's Logbook data service. The service provides
real-time access to information from QRZ.com logbooks. The API is documented
[here](https://www.qrz.com/docs/logbook/QRZLogbookAPI.html).

This client library was generated based on the OpenAPI specification in
the `api/openapi.yaml` file. However, the API itself is not well-described by
This client library was generated based on the OpenAPI specification in the
`api/openapi.yaml` file. However, the API itself is not well-described by
OpenAPI, so the generated library is supplemented with `wrapper.go`.

A simple application to demonstrate how to integrate the library is located in
`cmd/qrz-logbook/main.go`.

A QRZ.com XML subscription is required to take full advantage of the API. A
description of subscription plans and rates is available on the
description of subscription plans and rates is available on the
[QRZ.com website](http://www.qrz.com/i/subscriptions.html).
2 changes: 2 additions & 0 deletions api/openapi-config.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
packageName: qrzlog
withGoCodegenComment: true
globalProperties:
skipFormModel: false
44 changes: 25 additions & 19 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ openapi: 3.0.1
info:
contact:
email: [email protected]
description: This API provides methods for external programs to interact with the
description: |
This API provides methods for external programs to interact with the
QRZ Logbook using an HTTP REST interface. The QRZ Logbook is a combination free
and paid subscription service of QRZ. Some advanced features require a valid subscription
while the majority of operations are free to all QRZ members. All users of the
Expand All @@ -14,7 +15,7 @@ externalDocs:
description: Prose API description
url: http://files.qrz.com/static/qrz/The%20QRZ%20Logbook%20API.pdf
servers:
- url: https://logbook.qrz.com/api
- url: https://logbook.qrz.com/api
paths:
/:
post:
Expand All @@ -23,14 +24,14 @@ paths:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Request'
$ref: "#/components/schemas/Request"
required: true
responses:
"200":
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Response'
$ref: "#/components/schemas/Response"
description: OK
summary: The do-everything endpoint
components:
Expand All @@ -41,12 +42,12 @@ components:
description: A QRZ supplied logbook access key
type: string
ACTION:
description: Type of request, i.e. INSERT, DELETE, UPLOAD, etc.
description: "Type of request, i.e. INSERT, DELETE, UPLOAD, etc."
enum:
- INSERT
- DELETE
- STATUS
- FETCH
- INSERT
- DELETE
- STATUS
- FETCH
type: string
ADIF:
description: ADIF formatted input data
Expand All @@ -58,30 +59,35 @@ components:
description: A comma separated list of integer logid values
type: string
required:
- ACTION
- KEY
- ACTION
- KEY
type: object
Response:
properties:
RESULT:
description: OK when the operation succeeds, FAIL when the operation failed,
description: |
OK when the operation succeeds, FAIL when the operation failed,
AUTH when API Access lacked sufficient privileges for the operation, or
other action-specific codes
type: string
REASON:
description: Used with RESULT=FAIL to describe the specific reason for failure
description:
Used with RESULT=FAIL to describe the specific reason for failure
type: string
LOGIDS:
description: A comma separated list of logid values that were affected by
the action
description:
A comma separated list of logid values that were affected by the
action
type: string
LOGID:
description: The logid value of the record that was inserted or replaced.
(Singular "LOGID" response only used by INSERT as it is a single record
operation.)
description:
The logid value of the record that was inserted or replaced.
(Singular "LOGID" response only used by INSERT as it is a single
record operation.)
type: string
COUNT:
description: The number of QSO records that were affected by the action
description:
The number of QSO records that were affected by the action
type: string
DATA:
description: Used for action-specific data such as status reports
Expand Down
157 changes: 102 additions & 55 deletions api_default.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 27d7d59

Please sign in to comment.