Skip to content

docs: replace README with archive notice pointing to kintone/openapi-spec - #147

Open
shabaraba wants to merge 2 commits into
mainfrom
docs/archive-rest-api-spec
Open

shabaraba wants to merge 2 commits into
mainfrom
docs/archive-rest-api-spec

Conversation

@shabaraba

Copy link
Copy Markdown
Member

Why

The OpenAPI Description for the kintone REST API now lives in kintone/openapi-spec, which was made public on 2026-09-11. This repository is about to be archived, so its README has to tell a visitor where the current specification is before it becomes read-only.

What

Replaces the README with an archive notice and links to the new repository.

  • States up front that this repository is archived and that the files here no longer describe the current API
  • Links to kintone/openapi-spec and to the bundled openapi.yaml / openapi.json
  • Notes that the interactive website published from this repository is taken down, and points to the kintone REST API reference instead
  • Points feedback at the guidance in kintone/openapi-spec, since an archived repository takes no issues and no pull requests
  • Drops Concept, Usage, Releases and Limitations, along with the CI badge, as none of them apply once the repository is frozen

The LICENSE file and its reference are kept as they are.

Follow-up

Archiving the repository and taking down the GitHub Pages site are done separately, after this is merged.

Copilot AI lite review requested due to automatic review settings September 11, 2026 06:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Clarify archive status and issue/pull request availability during the transition.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Replaces the README with an archive notice directing users to the maintained OpenAPI specification.

Changes:

  • Links to kintone/openapi-spec and its YAML/JSON descriptions.
  • Points users to the current REST API reference.
  • Removes obsolete documentation and retains the license reference.
File summaries
File Summary
README.md Adds archival guidance and current API links; transition wording should accurately reflect repository status before and after archiving.
Review details

Suppressed comments (2)

README.md:16

  • The follow-up says the Pages site is taken down separately after this merge, so this statement is false for the interval immediately after merge. Please use transition-safe wording or perform the takedown before publishing a notice that says the site is already gone.
The interactive website that this repository used to publish is taken down. To browse the API, read

README.md:21

  • Because archiving is explicitly deferred until after this merge, this sentence incorrectly says that issues and pull requests are already disabled. Qualify it with the archive state so visitors are not misled during the transition.
This repository is archived, so it takes no issues and no pull requests. For anything about the
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated

[![CI](https://github.com/kintone/rest-api-spec/actions/workflows/ci.yaml/badge.svg)](https://github.com/kintone/rest-api-spec/actions/workflows/ci.yaml)
> [!IMPORTANT]
> This repository is archived and is no longer maintained.
@shabaraba
shabaraba force-pushed the docs/archive-rest-api-spec branch from 34b373c to 9d8f79d Compare September 11, 2026 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants