Apicurio-studio: Pratinjau dokumentasi memberikan kesalahan bahwa itu bukan Skema JSON yang valid

Dibuat pada 5 Jan 2021  ·  16Komentar  ·  Sumber: Apicurio/apicurio-studio

Saat melihat pratinjau dokumentasi untuk API ini, mendapatkan kesalahan:

Something went wrong...
"https://studio.apicur.io/download?type=api&format=json&dereference=true&id=24175" is not a valid JSON Schema
Stack trace
SyntaxError: "https://studio.apicur.io/download?type=api&format=json&dereference=true&id=24175" is not a valid JSON Schema
    at Function.syntax (https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js:29:28049)
    at https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js:49:54299

ReDoc Version: 2.0.0-rc.48
Commit: 7b78e75

Dapat mengedit dengan baik dan pengeditan menunjukkan 0 masalah

Sepertinya ini adalah masalah yang berulang karena sama dengan #1036 dan #1087

bug

Semua 16 komentar

Bisakah Anda mengunduh dan melampirkan desain API ke masalah GH ini atau (lebih baik) menambahkan saya sebagai kolaborator ke API yang gagal?

Juga, menekan url itu ( https://studio.apicur.io/download?type=api&format=json&dereference=true&id=24175 ) di browser Anda mungkin mengungkapkan beberapa hasil yang menarik.

@EricWittmann Terima kasih, kami telah menambahkan Anda sebagai kolaborator.
Pergi ke URL itu memberikan HTTP 200 dengan pesan "Kesalahan Server Internal".

Terima kasih atas bantuan Anda.

Tidak masalah. Saya melihatnya, tetapi Anda memiliki beberapa $ref s eksternal dalam dokumen (saya sangat senang melihat fitur itu digunakan), jadi Anda perlu menambahkan saya sebagai kolaborator pada dokumen apa pun yang dirujuk oleh yang ini. Sepertinya hanya #39013.

Tapi hei - setidaknya Anda tahu saya belum memberi diri saya akses pintu belakang/admin ke konten semua orang. :)

@EricWittmann menambahkan Anda ke 39013.
Pertanyaan di sini: Bisakah saya membuat proyek setidaknya readOnly terlihat untuk siapa saja? 39013 adalah definisi Skema untuk jsCalendar yang merupakan draf RFC yang bagus untuk ditampilkan

OK saya dapat mereproduksi masalah dan itu ada hubungannya dengan referensi ini. Saya perlu menggali ini dan mencari tahu apa yang terjadi. Saya akan melaporkan kembali ke sini ketika saya tahu lebih banyak.

Juga mengenai pertanyaan Anda tentang Hanya Baca - Anda dapat menggunakan fitur "Bagikan Dokumen" untuk menghasilkan tautan hanya-baca dan publik ke dokumentasi untuk API:

image

Namun, ReDoc tidak menampilkan skema secara terpisah, sehingga mungkin tidak terlalu membantu untuk kasus penggunaan ini. Jadi saya kira sayangnya tidak, tidak ada cara untuk melakukan apa yang Anda minta sekarang. Permintaan fitur yang bagus meskipun jika Anda ingin membuka masalah lain. :)

Diperbaiki oleh https://github.com/Apicurio/apicurio-data-models/pull/223

Ini akan diperbaiki pada rilis berikutnya.

@EricWittmann baru saja memeriksa, masih mengalami masalah yang sama:

Something went wrong...
"https://studio.apicur.io/download?type=api&format=json&dereference=true&id=24175" is not a valid JSON Schema
Stack trace
SyntaxError: "https://studio.apicur.io/download?type=api&format=json&dereference=true&id=24175" is not a valid JSON Schema
    at Function.syntax (https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js:29:28051)
    at https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js:49:54299

ReDoc Version: 2.0.0-rc.50
Commit: 8bee3d5

Ya - Anda akan mendapatkan kesalahan ini hingga kami melakukan rilis hulu Studio lainnya. Saya akan mencoba menyelesaikan ini sesegera mungkin.

Bug masih tetap ada, termasuk "Server Error" saat mencoba mengunduh dengan "Dereference all external $refs"

Coba sekarang.

Sebenarnya coba sekarang - saya yakin server telah diperbarui ke versi 0.2.48.Final sekarang.

Ya, bekerja untuk saya. Terima kasih!

Diperbarui ke 2.48 dan masih menerima kesalahan saat Pratinjau Dokumen.
image

Mengikuti URL di browser hanya menampilkan "Kesalahan Server Internal"

Server kami tidak terbuka untuk umum, apa cara terbaik untuk mendapatkan informasi yang Anda butuhkan untuk men-debug masalah?

EDIT: Saya membuka proyek Masalah, Tampilan Sumber sebagai JSON, menyalin teks ke clipboard. Kemudian saya membuat proyek baru, open source, menempelkan teks JSON, menyimpan proyek. Proyek baru membuat dokumentasi dengan benar.

@partialinfinity
Ketika Anda mendapatkan "Kesalahan Server Internal" di server, dapatkah Anda memeriksa log keluaran dari aplikasi? Saya juga menyarankan untuk memeriksa konsol browser - ada kemungkinan beberapa informasi debug berguna dapat ditemukan di sana.

Apakah halaman ini membantu?
0 / 5 - 0 peringkat